Skip to content

Add/documentation #237

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 4 commits into from
Nov 4, 2025
Merged

Add/documentation #237

merged 4 commits into from
Nov 4, 2025

Conversation

@AHReccese
Copy link
Member

@AHReccese AHReccese commented Oct 17, 2025 •
edited
Loading

Reference Issues/PRs

Add API Reference of main user facing classes of PyMilo.

I tried to follow the structure we have chosen for Memor.

What does this implement/fix? Explain your changes.

Any other comments?

@AHReccese AHReccese self-assigned this Oct 17, 2025
@AHReccese AHReccese marked this pull request as ready for review October 20, 2025 16:13
@AHReccese AHReccese added the documentation Improvements or additions to documentation label Oct 20, 2025
sadrasabouri
sadrasabouri reviewed Oct 21, 2025
View reviewed changes
Copy link
Member

@sadrasabouri sadrasabouri left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I left some minor comments; they're not a must-have but nice-to-have.

@codecov
Copy link

codecov bot commented Nov 4, 2025 •
edited
Loading

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 74.38%. Comparing base (6bb131f) to head (d1ced89).
⚠️ Report is 12 commits behind head on dev.

Additional details and impacted files 
@@            Coverage Diff             @@
##              dev     #237      +/-   ##
==========================================
- Coverage   80.00%   74.38%   -5.61%     
==========================================
  Files          49       49              
  Lines        2104     2314     +210     
  Branches      376      410      +34     
==========================================
+ Hits         1683     1721      +38     
- Misses        321      502     +181     
+ Partials      100       91       -9

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@AHReccese
Copy link
Member Author

AHReccese commented Nov 4, 2025

@sadrasabouri @sepandhaghighi

  • I've dropped the Type column
  • I've explained details of enum classes in text (not in table)
  • For input params with enum type, I've mention the associated enum class in the description column.

please review at your earliest convenience so I can reply and end the thread in joss review (today is the due date).

sadrasabouri
sadrasabouri approved these changes Nov 4, 2025
View reviewed changes
Copy link
Member

@sadrasabouri sadrasabouri left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good now

@sepandhaghighi sepandhaghighi added this to the pymilo v1.4 milestone Nov 4, 2025
sepandhaghighi
sepandhaghighi approved these changes Nov 4, 2025
View reviewed changes
Copy link
Member

@sepandhaghighi sepandhaghighi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 🚀

@sepandhaghighi sepandhaghighi merged commit 7acd226 into dev Nov 4, 2025
22 of 23 checks passed
@sepandhaghighi sepandhaghighi deleted the add/documentation branch November 4, 2025 20:52
@AHReccese AHReccese mentioned this pull request Nov 5, 2025
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sepandhaghighi sepandhaghighi sepandhaghighi approved these changes

@sadrasabouri sadrasabouri sadrasabouri approved these changes

Assignees

@AHReccese AHReccese

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

pymilo v1.4

Development

Successfully merging this pull request may close these issues.

4 participants

@AHReccese @sepandhaghighi @sadrasabouri